package com.eedi.framework.template.service;

import com.eedi.framework.common.enums.CommonStatusEnum;
import com.eedi.framework.common.pojo.PageResult;
import com.eedi.framework.template.controller.sys.vo.role.SysTemplateRoleSaveReq;
import com.eedi.framework.template.controller.sys.vo.role.SysTemplateRoleUpReq;
import com.eedi.framework.template.dal.dataobject.SysTemplateRoleDO;
import com.eedi.framework.template.enums.SysTemplateDataScopeEnum;
import com.eedi.framework.template.controller.sys.vo.role.SysTemplateRoleSimpleResp;
import com.eedi.framework.template.controller.sys.vo.role.SysTemplateRolePageReq;
import javax.validation.Valid;
import java.util.Collection;
import java.util.List;
import java.util.Set;
/**
 * 角色 Service 接口
 *
 * @author 永聚长青源码
 */
public interface SysTemplateRoleService {

    /**
     * 创建角色
     *
     * @param createReqVO 创建角色信息
     * @return 角色编号
     */
    String createRole(@Valid SysTemplateRoleSaveReq createReqVO);

    /**
     * 更新角色
     *
     * @param updateReqVO 更新角色信息
     */
    void updateRole(@Valid SysTemplateRoleUpReq updateReqVO);

    /**
     * 删除角色
     *
     * @param sysRoleId 角色编号
     */
    void deleteRole(String sysRoleId);

    /**
     * 更新角色状态
     *
     * @param sysRoleId 角色编号
     * @param status 状态
     */
    void updateRoleStatus(String sysRoleId, CommonStatusEnum status);

    /**
     * 设置角色的数据权限
     *
     * @param sysRoleId 角色编号
     * @param dataScope 数据范围
     * @param dataScopeDeptIds 部门编号数组
     */
    void updateRoleDataScope(String sysRoleId, SysTemplateDataScopeEnum dataScope, Set<String> dataScopeDeptIds);

    /**
     * 获得角色
     *
     * @param sysRoleId 角色编号
     * @return 角色
     */
    SysTemplateRoleDO getRole(String sysRoleId);

    /**
     * 获得角色，从缓存中
     *
     * @param sysRoleId 角色编号
     * @return 角色
     */
    SysTemplateRoleDO getRoleFromCache(String sysRoleId);

    /**
     * 获得角色列表
     *
     * @param sysRoleIds 角色编号数组
     * @return 角色列表
     */
    List<SysTemplateRoleDO> getRoleList(Collection<String> sysRoleIds);

    /**
     * 获得角色列表
     *
     * @param sysRoleIds 角色编号数组
     * @return 角色列表
     */
    List<SysTemplateRoleSimpleResp> getRoleSimpleList(Collection<String> sysRoleIds);
    /**
     * 获得角色数组，从缓存中
     *
     * @param sysRoleIds 角色编号数组
     * @return 角色数组
     */
    List<SysTemplateRoleDO> getRoleListFromCache(Collection<String> sysRoleIds);

    /**
     * 获得角色列表
     *
     * @param statuses
     * @return
     */
    List<SysTemplateRoleDO> getRoleListByStatus(Collection<CommonStatusEnum> statuses);

    /**
     * 获得所有角色列表
     *
     * @return 角色列表
     */
    List<SysTemplateRoleDO> getRoleList();

    /**
     * 获得角色分页
     *
     * @param reqVO 角色分页查询
     * @return 角色分页结果
     */
    PageResult<SysTemplateRoleDO> getRolePage(SysTemplateRolePageReq reqVO);

    /**
     * 判断角色编号数组中，是否有管理员
     *
     * @param sysRoleIds 角色编号数组
     * @return 是否有管理员
     */
    boolean hasAnySuperAdmin(Collection<String> sysRoleIds);

    /**
     * 校验角色们是否有效。如下情况，视为无效：
     * 1. 角色编号不存在
     * 2. 角色被禁用
     *
     * @param sysRoleIds 角色编号数组
     */
    void validateRoleList(Collection<String> sysRoleIds);

    /**
     * 根据角色code获取角色简要信息
     * @param sysRoleCode 角色code
     * @return 角色简要信息列表
     */
    List<SysTemplateRoleSimpleResp> getRoleByCode(String sysRoleCode);


}
